﻿// Copyright 2005, 2006 - Morten Nielsen (www.iter.dk)
//
// This file is part of SharpMap.
// SharpMap is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
// 
// SharpMap is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public License
// along with SharpMap; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

namespace ProjNet.CoordinateSystems.Transformations
{
    /// <summary>
    /// Describes core information of a coordinate transformation
    /// </summary>
    public interface ICoordinateTransformationCore
    {

        /// <summary>
        /// Source coordinate system.
        /// </summary>
        CoordinateSystem SourceCS { get; }

        /// <summary>
        /// Target coordinate system.
        /// </summary>
        CoordinateSystem TargetCS { get; }
    }

    /// <summary>
    /// Describes a coordinate transformation. This interface only describes a 
    /// coordinate transformation, it does not actually perform the transform 
    /// operation on points. To transform points you must use a math transform.
    /// </summary>
    public interface ICoordinateTransformation : ICoordinateTransformationCore
    {
        /// <summary>
        /// Human readable description of domain in source coordinate system.
        /// </summary>
        string AreaOfUse { get; }

        /// <summary>
        /// Authority which defined transformation and parameter values.
        /// </summary>
        /// <remarks>
        /// An Authority is an organization that maintains definitions of Authority Codes. For example the European Petroleum Survey Group (EPSG) maintains a database of coordinate systems, and other spatial referencing objects, where each object has a code number ID. For example, the EPSG code for a WGS84 Lat/Lon coordinate system is �4326�
        /// </remarks>
        string Authority { get; }

        /// <summary>
        /// Code used by authority to identify transformation. An empty string is used for no code.
        /// </summary>
        /// <remarks>The AuthorityCode is a compact string defined by an Authority to reference a particular spatial reference object. For example, the European Survey Group (EPSG) authority uses 32 bit integers to reference coordinate systems, so all their code strings will consist of a few digits. The EPSG code for WGS84 Lat/Lon is �4326�.</remarks>
        long AuthorityCode { get; }

        /// <summary>
        /// Name of transformation.
        /// </summary>
        string Name { get; }

        /// <summary>
        /// Gets the provider-supplied remarks.
        /// </summary>
        string Remarks { get; }

        /// <summary>
        /// Gets math transform.
        /// </summary>
        MathTransform MathTransform { get; }

        /// <summary>
        /// Semantic type of transform. For example, a datum transformation or a coordinate conversion.
        /// </summary>
        TransformType TransformType { get; }
    }
}
